Creating and configuring an API Proxy component

Create and configure an API Proxy component in on the Build page.

Procedure

1. On the Build page in the Component Explorer, navigate to the folder where you want to create the component.

2. Click the arrow next to the folder.

3. Create New Component by choosing any of the following options:

   • Click and select New Component.

     Or

   • Click and select New Component.

   
   The Create Component dialog opens.

4. In Type, select API Proxy.

5. Click Create. The General tab opens. The component configuration panel appears on the General tab with the name you entered.

   a. In the API Type section, select the type of routing on the API Gateway — REST, SOAP, OData or GraphQL.

   b. Optional: Click Import OpenAPI Specification File. The Import OpenAPI Specification File wizard opens.

   • In the wizard’s first screen, select Import from a file or Import from a URL to determine the import method.

   • Click Next to go the next screen. In that screen:

     • If importing from a file, click Choose a File and in the system file selection dialog, select the file to upload.

     • If importing from a URL, enter the External Service URL at which the file resides, and, if needed, enter the User Name and Password.

   • Click Next to go the final screen, in which you can select fields for importing.

     • In the Select Fields to Import screen, select all fields to import into your API Proxy and click Next.

     • In the Select API Server URL to Import screen, select the URL to import into your API Proxy and click Next.

   • In the Summary screen, verify that the fields are correct.

   • Click Finish to run the import request.

   The selected fields are imported, and you are returned to the General Tab of the component configuration panel.

   c. Enter values for Published API Title, Published Version Number, and, optionally, Published Description for the API that you are deploying.

   note

   If you imported an OpenAPI specification file (as mentioned in step 5(b.)) and selected the API_TITLE, API_VERSION, and API_DESCRIPTION fields for importing, then Published API Title, Published Version Number, and Published Description are automatically set with the values of API_TITLE, API_VERSION, and API_DESCRIPTION.

   d. In the Base API Path field, enter the base portion of the URL for requests to the API defined by the API object.

   The full URL is generated when the API Proxy component is deployed.

6. Click Server tab. The Server tab opens.

   a. In the API Server URL field, enter the URL to which the API Gateway sends API service requests.

   note

   If you imported an OpenAPI specification file (as mentioned in step 5(b.)) and selected the API_URL field for importing, then API Server URL is automatically set with the value of API_URL.

   b. Optional: In the Health Check URL field, enter the URL to which API service heath checks can be sent.

   c. In Authentication type, select either None, Basic Authentication or Pass-Through as the Authentication Type to be used on the server on which the API service is hosted.

   • If you selected Basic Authentication type, then provide User Name and Password.

   • If you selected Pass-Through type, the original authorization header is passed to the target endpoint.

   d. Optional: In the Forward original authorization header, select this checkbox if you want to pass the original authorization header in the request.

   e. Optional: In the Custom Headers section, specify custom headers that will be included by the API Gateway in API service requests:

   1. Click Add Header.

   2. In the Key field, enter the header name.

      Header names can contain alphanumeric characters and special characters !#$%&'*+.^`~-_.

   3. Set the header value by doing one of the following:

      • To set an unencrypted value, enter it in the Value field.

      • To set an encrypted value, click Encrypt, click Click to Set, enter the Password, and click Apply.

      For each additional header name you are specifying, repeat steps 1–3.

7. Optional: Click Documentation tab. The Documentation tab opens.

   a. In Publisher, select an organization component to reuse publisher information across multiple API Service/Proxy components or trading partner components, and then click to add contact information of the selected organization.

   b. In Publisher Name, enter the name of the person or organization acting as the API publisher.

   note

   If you imported an OpenAPI specification file (as mentioned in step 5(b.)) and selected CONTACT_NAME, CONTACT_EMAIL, CONTACT_URL, LICENSE_NAME, LICENSE_URL, and TERMS_OF_SERVICE then Publisher Name, Publisher Email, Publisher URL, License Title, License Information, and Terms of Service are automatically set with the values of CONTACT_NAME, CONTACT_EMAIL, CONTACT_URL, LICENSE_NAME, LICENSE_URL, and TERMS_OF_SERVICE, respectively.

   c. In Publisher Email, enter the publisher's email address.

   d. In Publisher URL, enter the publisher's URL, including protocol, of the document containing the contact information of the publisher. Make sure you post this document to that URL before you deploy the API Proxy component.

   e. In License Title, enter the license title for the API.

   f. In License Information, enter the URL, including protocol, of the API license document. Make sure you post this document to that URL before you deploy the API Proxy component.

   g. In Terms of Service, enter the URL, including protocol, of the document containing the terms of service. Make sure you post this document to that URL before you deploy the API Proxy component.

8. Click Save or Save and Close.

Next steps

If you are ready to deploy the API Proxy component, after clicking Save, click Create Packaged Components. The Create Packaged Component wizard opens. Complete the steps in the wizard and click the Deploy button on the final confirmation message. Your component now appears in the list of packaged components in the Deploy > Packaged Components page, and in the list of deployed components on the Deploy > Deployments page.